# Copyright (C) 2025-present MongoDB, Inc.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the Server Side Public License, version 1,
# as published by MongoDB, Inc.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# Server Side Public License for more details.
#
# You should have received a copy of the Server Side Public License
# along with this program. If not, see
# <http://www.mongodb.com/licensing/server-side-public-license>.
#
# As a special exception, the copyright holders give permission to link the
# code of portions of this program with the OpenSSL library under certain
# conditions as described in each individual source file and distribute
# linked combinations including the program with the OpenSSL library. You
# must comply with the Server Side Public License in all respects for
# all of the code used other than as permitted herein. If you modify file(s)
# with this exception, you may extend this exception to your version of the
# file(s), but you are not obligated to do so. If you do not wish to do so,
# delete this exception statement from your version. If you delete this
# exception statement from all source files in the program, then also delete
# it in the license file.

"""Faker-specific API items."""

import datagen.random
import faker


# This class makes it easier to hook the correlated RNG with the Faker machinery.
class CorrelatedGenerator(faker.generator.Generator):
    def __init__(self, *args, **kwargs):
        super(CorrelatedGenerator, self).__init__(*args, **kwargs)
        self.random = datagen.random.CorrelatedRng()

    def clear(self):
        self.random.clear()


# This is a base class for providing correlated data.
class CorrelatedProvider(faker.providers.python.Provider):
    __use_weighting__ = True
